COMPASS is a complex application and relies on several other software components to work. In order to ease up the deployment process a docker-compose.yml file is provided, so assuming you have a working Docker Compose environment, the deployment process will be a matter of running a few commands.

In case you want to manually deploy COMPASS in your environment there will be more steps you will need to take care of such as installing the web-server, the DBMS, etc.


Have a look at the requirements.txt file for details. COMMAND>_ main dependencies are:

Docker Compose

Assuming that you have Docker Compose correctly installed, you should be able to perform the following steps:

# 1. clone the repository
git clone

# 2. build
docker-compose build

# 3. start docker
docker-compose up -d

# 4. create database schema
docker-compose exec web python migrate

That’s it! You should be able to point your browser to http://localhost/graphql and see the GraphiQL interface.

Manual Deploy

One easy way to understand what you need to do to manually deploy COMPASS is to have a look at 2 files:

In a nutshell, after having installed and configured Nginx (or another web-server to run Django applications), PostgreSQL

pip3 install --upgrade pip
pip3 install -r requirements.txt

Now you should be ready configure Django (check the documentation for details), create the database schema and run the application.

python migrate


COMPASS id a Django application so refer to the Django docs for database configuration